package com.linxuan.reggie.config;

import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import com.linxuan.reggie.common.JacksonObjectMapper;
import lombok.extern.slf4j.Slf4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.List;

/**
 * SpringMVC配置类
 * EnableSwagger2注解：开启Swagger2的自动配置
 */
@Slf4j
@Configuration
@EnableKnife4j
@EnableSwagger2
public class WebMvcConfig extends WebMvcConfigurationSupport {

    /**
     * 设置静态资源访问过滤，当前类需要设置为配置类，并被扫描加载
     *
     * @param registry 资源映射
     */
    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        log.info("开始静态资源映射");
        registry.addResourceHandler("/index.html").addResourceLocations("classpath:/index.html");
        // 当访问/backend/**时候，从classpath:/backend/目录下查找内容
        registry.addResourceHandler("/backend/**").addResourceLocations("classpath:/backend/");
        // 当访问/front/**时候，从classpath:/front/目录下查找内容
        registry.addResourceHandler("/front/**").addResourceLocations("classpath:/front/");
        // 设置静态资源映射 否则接口文档页面无法访问 这些是Swagger接口文档页面
        registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    }

    /**
     * 在WebMvcConfig配置类中扩展Spring mvc的消息转换器，
     * 在此消息转换器中使用提供的对象转换器进行Java对象到json数据的转换
     *
     * @param converters 消息转换器集合 List<HttpMessageConverter>
     */
    @Override
    protected void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
        // 创建消息转换器
        MappingJackson2HttpMessageConverter messageConverter = new MappingJackson2HttpMessageConverter();
        // 设置对象转换器，底层使用Jackson将Java转换为json
        messageConverter.setObjectMapper(new JacksonObjectMapper());
        // 将上面的消息转换器对象追加到mvc框架的转换器集合中
        converters.add(0, messageConverter);
        super.extendMessageConverters(converters);
    }

    /**
     * Docket 实例关联上 apiInfo()
     *
     * @return Docket Swagger实例Bean是Docket，所以通过配置Docket实例来配置Swaggger
     */
    @Bean
    public Docket createRestApi() {
        // 文档类型
        return new Docket(DocumentationType.SWAGGER_2)
                // Docket 实例关联上 apiInfo()
                .apiInfo(apiInfo())
                // 通过.select()方法，去配置扫描接口
                .select()
                // RequestHandlerSelectors配置如何扫描接口
                .apis(RequestHandlerSelectors.basePackage("com.linxuan.reggie.controller"))
                // 配置如何通过path过滤，即这里扫描所有请求
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 可以通过apiInfo()属性配置文档信息，这些配置的信息在http://localhost:8080/swagger-ui.html显示
     *
     * @return apiInfo
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 标题
                .title("瑞吉外卖")
                // 版本
                .version("1.0")
                // 描述
                .description("瑞吉外卖接口文档")
                .build();
    }
}
